home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / wd.zip / EVAL.DOC < prev    next >
Text File  |  1988-02-04  |  32KB  |  1,325 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                   PRELIMINARY
  15.  
  16.  
  17.  
  18.                  PROGRAM SPECIFICATION
  19.  
  20.  
  21.               STORAGE MANAGEMENT EVALUATOR
  22.  
  23.  
  24.                      (EVAL)
  25.  
  26.  
  27.  
  28.               SPECIFICATION NO. XX-XXXXXX
  29.  
  30.  
  31.  
  32.                 FEBRUARY 4,1988
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.      1.0 SCOPE
  59.  
  60.  
  61. This   document   describes  the  functional  characteristics  of  the    Storage
  62. Management  Evaluator  (EVAL).    EVAL  is  a diagnostic program designed for use
  63. with  the  IBM    AT   to  test  and  evaluate hard and floppy storage management
  64. subsystems.  It  is  especially  suited  for  error  rate testing. The Features
  65. section  describes  the operation and features of the program, including how to
  66. invoke    EVAL,  diagnostic screen definition command structure error methodology
  67. and  miscellaneous  features.  The  Commands section describes the command set,
  68. giving    a  detailed explanation of each command. Appendix A and B describe each
  69. status code, task file, and associated error reporting.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.      2.0 FEATURES
  77.  
  78.  
  79.      2.1 Invoking EVAL
  80.  
  81. EVAL  is  invoked  at  the PC-DOS command line,  or batch file command line, as
  82. follows:
  83.  
  84.            c>EVAL [cmd-file]
  85.  
  86. The  optional  cmd-file  parameter  specifies  a file from which EVAL will read
  87. commands  until  it encounters an "end" command. All commands described in this
  88. specification  may  be    used  in   command  files  except "edit", "run", "def",
  89. "duw", and "dur".
  90.  
  91.  
  92.      2.2 Floppy Diagnostic Screen
  93.  
  94. Figure    1 shows the main floppy diagnostic screen. The screen is divided into 4
  95. windows,  a  command  line,  and  a  message  line.  The  command  line will be
  96. described  in  3.0,  and  the  message    line will be referred to throughout the
  97. specification. The following is a brief description of the 4 windows.
  98.  
  99.  
  100.      2.2.1 Parameter Window
  101.  
  102. The  upper  left  window  of the screen is the parameter window. The parameters
  103. shown  will  be  used  for  the  next disk operation. The parameters are: drive
  104. type,  drive  number,  cylinder  number,  head number, sector number, and block
  105. size.  The  parameters are updated dynamically during command execution, if the
  106. operation changes a parameter (see individual commands in section 3).
  107.  
  108.  
  109.      2.2.2 Status Window
  110.  
  111. The  status  window  (lower  left)  shows  the    latest    status    returned  after
  112. execution  of  a  command which accesses the controller. The status information
  113. includes  the  status  code,  status  registers  and cylinder, head, and sector
  114. numbers  returned by the controller. Appendix B gives a detailed explanation of
  115. status codes and associated errors.
  116.  
  117.  
  118.      2.2.3 Error Count Window
  119.  
  120. The  error  count  window  (upper  right)  shows total error counts, as well as
  121. individual  error  counts  for 5 groups of errors. The counts are kept for both
  122. hard  and soft errors. See 2.5.1 for an explanation of hard and soft errors and
  123. appendix B for a detailed explanation of error reporting.
  124.  
  125.      2.2.4  Error Report Window
  126.  
  127. The  error  report  window  (lower  right)  shows  the last 5 errors which have
  128. occurred  since  the  diagnostic  began,  or since the last "zero" command was.
  129. issued    Appendix B explains each error in full detail.
  130.  
  131.  
  132.      2.3 Hard  Diagnostic Screen
  133.  
  134. Figure    2  shows  the main hard diagnostic screen. The screen is divided into 4
  135. windows,  a  command  line,  and  a  message  line.  The  command  line will be
  136. described  in  3.0,  and  the  message    line will be referred to throughout the
  137. specification. The following is a brief description of the 4 windows.
  138.  
  139.  
  140.      2.3.1 Parameter Window
  141.  
  142. The  upper  left  window  of the screen is the parameter window. The parameters
  143. shown  will  be  used  for  the  next disk operation. The parameters are: drive
  144. number,  cylinder  number,  head  number,  sector  number,  and block size. The
  145. parameters  are  updated dynamically during command execution, if the operation
  146. changes a parameter (see individual commands in section 3).
  147.  
  148.  
  149.      2.3.2 Disk Type Window
  150.  
  151. The  disk  type  window  (lower left) shows the disk drive boundary parameters.
  152. The  type  information    includes  the maximum cylinders, maximum heads, maximum
  153. sectors,    precomp  cylinder  number,    retry  flag,  step rate, and interleave
  154. value.
  155.  
  156.  
  157.      2.3.3 Task File Window
  158.  
  159. The  task  file  window  (upper  right)  shows    the task file returned from the
  160. controller  after  the    command  was  completed.  Appendix  A  gives a detailed
  161. explanation of the task file and associated errors.
  162.  
  163.  
  164.  
  165.  
  166.      2.3.4  Error Report Window
  167.  
  168. The  error  report  window  (lower  right)  shows  the last 5 errors which have
  169. occurred  since  the  diagnostic  began,  or  since the last "zero" command was
  170. issued. Appendix A explains each error in full detail.
  171.  
  172.  
  173.  
  174.  
  175.      2.4 Command Structure
  176.  
  177. In  the  interactive  mode (commands being input from the keyboard), the cursor
  178. will  reside  on  the command line, which begins with the CMD> prompt. Commands
  179. are  typed  in lower or upper case. A carriage return  <CR>  ends command entry
  180. and  initiates    command execution. Multiple commands may be entered on the same
  181. line,  separated  by   commas. Commands are separated from parameters by one or
  182. more of the following:    space  tab  =  /  :  (    )
  183.  
  184.  
  185.      2.4.1 Command Types
  186.  
  187. From a command entry standpoint, there are 6 types of commands:
  188.  
  189.      type 1       cmd
  190.      type 2       cmd|<choice>
  191.      type 3       cmd|<param>
  192.      type 4       cmd|<string>
  193.      type 5       cmd|<test>
  194.      type 6       cmd|<special>
  195.  
  196. The  six  types  of  commands may be freely mixed on the same line. See section
  197. 3.0 for complete listing.
  198.  
  199.  
  200.      2.4.2 Command Line Repeat
  201.  
  202. A  command  line  may  be  repeated  up to 32,762 times, simply by entering the
  203. desired  command  (or  a  string  of  commands)  followed by a #, followed by a
  204. number.   After  the <CR> is entered, the commands on the line will be executed
  205. repeatedly,  just  as  if  the    line were entered the number of times specified
  206. behind    the  #.  In  addition, a repeat count is shown on the message line, and
  207. decrements down with each command line execution.
  208.  
  209. If  the  Escape  key  is  hit  during  a  line    repeat,  the  repeat  count  is
  210. automatically zeroed.
  211.  
  212.      Example:
  213.  
  214.       CMD>r,incs #30
  215.  
  216. will perform a read, increment the sector count operation 30 times.
  217.  
  218.  
  219.  
  220.  
  221.      2.5 Error Methodology
  222.  
  223.  
  224.      2.5.1 Hard and Soft Errors
  225.  
  226. Errors    are separated into two categories - hard errors and soft errors. A hard
  227. error  is defined as an error which is not recoverable after a specified number
  228. of  retries  (see "rc"). A soft error is defined as an error which is recovered
  229. during    retries.  In  other  words, a hard error persists through the specified
  230. number of retries; a soft error does not.
  231.  
  232. A  hard  error    is  distinguished  in the error report window, and in the error
  233. file by a 'H' prefix and a soft error is prefixed by a 'S'.
  234.  
  235.  
  236.      2.5.2 Error logging
  237.  
  238. In  addition  to  showing  the    last 5 errors in the error reporting window, an
  239. error  log  file  can  be  kept  on disk for later review. Upon invocation, all
  240. errors    are  logged  to  a specified file (see "errlog"). The file may later be
  241. dumped to the screen interactively (see "def").
  242.  
  243.  
  244.      2.6  Buffer Screen
  245.  
  246. The  buffer  screen  can  be reached from the Floppy or Hard screen by giving a
  247. dur  (dump  read buffer) or duw (dump write buffer). The buffer screen displays
  248. one  sector  of  data  at a time that can be edited. The arrow keys are used to
  249. select the byte to edit and the page keys are used to choose the sector.
  250.  
  251.      2.7 Help Screen
  252.  
  253. The  help screen can be reached from the floppy or hard screen by giving a help
  254. command.  The  help  screen  displays all of the commands in alphabetical order
  255. with a short description after it.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.      3.0 COMMANDS
  263.  
  264. The  command  set in EVAL closely resembles that of VHD. Bellow one will find a
  265. list  of  all  the  commands  by  type    and alphabetic. Before getting into the
  266. commands we should look at the formats of the commands.
  267.  
  268.  
  269.      type 1       cmd
  270.      type 2       cmd|<choice>
  271.      type 3       cmd|<param>
  272.      type 4       cmd|<string>
  273.      type 5       cmd|<test>
  274.      type 6       cmd|<special>
  275.  
  276.  
  277.